/*
 * Copyright 2011-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.neo4j.bookmark;

import java.util.Collection;

/**
 * Bookmark manager keeps track of Neo4j transaction bookmarks
 *
 * @author Frantisek Hartman
 * @see org.springframework.data.neo4j.annotation.EnableBookmarkManagement
 */
public interface BookmarkManager {

	/**
	 * Return stored bookmarks
	 *
	 * @return bookmarks
	 */
	Collection<String> getBookmarks();

	/**
	 * Stores bookmark to this manager
	 *
	 * @param bookmark new bookmark to store
	 * @param previous previous bookmarks that are to be replaced by new bookmark, may be empty
	 */
	void storeBookmark(String bookmark, Collection<String> previous);
}
